// 
// Entify project
//  
// Author:
//       Lauri Taimila <lauri@taimila.com>
// 
// Copyright (c) 2010 Lauri Taimila
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;

namespace Taimila.Entify
{
	/// <summary>
	/// Paging filter can be used to limit the number of entities
	/// returned by entity request. Paging filter is interpreted
	/// after all the other filters.
	/// </summary>
	public sealed class PagingFilter
	{
		/// <summary>
		/// Create a new PagingFilter.
		/// </summary>
		/// <param name="limit">
		/// Maximum number of entities returned by EntityRequest. <see cref="System.Int32"/>
		/// </param>
		/// <param name="offset">
		/// Offset from the beginning of the results. <see cref="System.Int32"/>
		/// </param>
		public PagingFilter (int limit, int offset)
		{
			this.Limit = limit;
			this.Offset = offset;
		}
		
		/// <summary>
		/// Maximum number of entities returned by EntityRequest.
		/// </summary>
		public int Limit
		{
			get;
			set;
		}
		
		/// <summary>
		/// Offset for getting entities. This allows returning entities "page by page".
		/// </summary>
		public int Offset
		{
			get;
			set;
		}
	}
}
